Class STPProcessImpl

All Implemented Interfaces:
IPCObject, Process, STPProcess

public class STPProcessImpl extends ProcessImpl implements STPProcess
Information provided by the PKI file:

    \class StpProcess
    
    \brief StpProcess handles and manipulates STP processes.
    
    \example network().getDevice("Switch0").getProcess("StpMainProcess").getStpProcess(1)
    
Author:
Auto-generated
  • Constructor Details

  • Method Details

    • getSwitchPriority

      public int getSwitchPriority()
      Information provided by the PKI file:
      
          \brief Returns the priority.
          
          \return int, the priority.
          
              
      Specified by:
      getSwitchPriority in interface STPProcess
      Returns:
      int Returns a int
    • getRootBridgeId

      public String getRootBridgeId()
      Information provided by the PKI file:
      
          \brief Returns the root bridge ID.
          
          \return string, the root bridge ID.
          
              
      Specified by:
      getRootBridgeId in interface STPProcess
      Returns:
      String Returns a String
    • getPortCount

      public int getPortCount()
      Information provided by the PKI file:
      
          \brief Returns the number of ports in the STP process.
          
          \return int, the number of ports in the STP process.
          
              
      Specified by:
      getPortCount in interface STPProcess
      Returns:
      int Returns a int
    • isRootBridge

      public boolean isRootBridge()
      Information provided by the PKI file:
      
          \brief Returns true if this switch is the root bridge, otherwise false.
          
          \return bool, true if this switch is the root bridge, otherwise false.
          
              
      Specified by:
      isRootBridge in interface STPProcess
      Returns:
      boolean Returns a boolean
    • getSwitchId

      public String getSwitchId()
      Information provided by the PKI file:
      
          \brief Returns the ID for this switch.
          
          \return string, the ID for this switch.
          
              
      Specified by:
      getSwitchId in interface STPProcess
      Returns:
      String Returns a String
    • hasPort

      public boolean hasPort(String portName)
      Information provided by the PKI file:
      
          \brief Returns true if the specified port is in this STP process, otherwise false.
          
          \param portName,    portName can be one of the following plus a port number where appropriate:
          Console, Aux, Ethernet, FastEthernet, GigabitEthernet,
          Serial, Wireless, Loopback, Vlan, Modem, Coaxial, Rs232, Async.
          Example: FastEthernet0/0
          
          \return bool, true if the specified port is in this STP process, otherwise false.
          
              
      Specified by:
      hasPort in interface STPProcess
      Parameters:
      portName - Takes in a parameter of portName
      Returns:
      boolean Returns a boolean
    • getRootPort

      public SwitchPort getRootPort()
      Information provided by the PKI file:
      
          \brief Returns the root port in this STP process.
          
          \return SwitchPort, the SwitchPort object.
          
              
      Specified by:
      getRootPort in interface STPProcess
      Returns:
      SwitchPort Returns a SwitchPort
    • getRootPathCost

      public int getRootPathCost()
      Information provided by the PKI file:
      
          \brief Returns the root path cost.
          
          \return int, the root path cost.
          
              
      Specified by:
      getRootPathCost in interface STPProcess
      Returns:
      int Returns a int